Add missing docs for System.Collections[.Generic] #4121
Conversation
carlossanlop
added
new-content
|
Consider mentioning any expected exceptions as well. Can you please check if any of these APIs throw? |
Hmm weird, I made triple-slash additions in the source locally so I could use the porting tool, but somehow the exceptions weren't picked up. I'll hand-write them and push a commit. |
@layomia Exceptions don't get picked up by default by the tool because there is no easy way to determine if an exception message has been added or not (usually the message gets modified during language review, making it impossible to compare with the original message). To enable the option, add the argument Note: I fixed a bug in the tool today in the exception porting code. Please pull the latest changes to your machine. |
|
@carlossanlop, I've added the exceptions - PTAL. |
| <remarks>To be added.</remarks> | ||
| <exception cref="System.ArgumentException"><paramref name="collection" /> contains one or more duplicated keys.</exception> |
There was a problem hiding this comment.
Hey @layomia did you manually add the exceptions or did you port them with the tool? I ask because the exception cref DocIDs are incomplete (missing the API category prefix), and if it's the tool's fault, I should get it fixed.
This is how it should look:
| <exception cref="System.ArgumentException"><paramref name="collection" /> contains one or more duplicated keys.</exception> | |
| <exception cref="T:System.ArgumentException"> | |
| <paramref name="collection" /> contains one or more duplicated keys.</exception> |
Also, if the inner value of the <exception> starts with an xml tag, we usually prefer to start the text with an endline.
There was a problem hiding this comment.
I added them manually in e42c4c8, but used the tool to port the in the new commit. It missed the one added in Queue1.xml (not sure how), so I applied your suggestion in e0f79cf and rebased.
The command I used was:
DocsPortingTool -docs D:\repos\dotnet-api-docs\xml -tripleslash D:\repos\dotnet_runtime\artifacts\bin\coreclr\Windows_NT.x64.Release\IL\,D:\repos\dotnet_runtime\artifacts\bin\ -includedassemblies System.Collections,System.Collections.Generic,mscorlib -excludedassemblies System.Collections.Immutable,System.Collections.Specialized,System.Collections.Concurrent -save true -skipExceptions false
There was a problem hiding this comment.
Thanks for adding the exceptions, @layomia. Can you please take a look at my suggestions and the question I asked on the first one?
Contributes to #3914.
Adds docs for 1.x gaps not added in #4060 (which addressed System.Collections.Immutable)